Any text argument (t in the request summary below) may be zero to six words. Quotes may be used to include blanks in a word. The text can be empty, but unlike normal macros, the next line is not used (i.e. all text MUST be included on the same line as the macro command).
A prevailing indent distance is generally NOT remembered between successive indented paragraphs, and is reset to default value upon reaching a non-indented paragraph (i.e. at .SH, .PP, or .SS). In contrast with normal procedure, all indents (tabs) are 8 spaces (0.8i) instead of 5 (0.5i). This can be changed by modifying tmac.an.
Some nroff requests may be unsafe in conjunction with this package. However, those listed below may be used with impunity:
.bp begin new page
.br break output line
.sp n insert n spacing lines
.nf begin no-fill mode
.fi begin fill mode (end no-fill)
Font changes with \fF are also allowed; for example, '\fIword\fR' will italicize ``word''. Note that only letters for fonts are currently allowed (R, I, B), no numbers. You can also use \sN to change to the small font, e.g. '\s-2word\s0' will make ``word'' smaller (only when using manpager(1), however).
Name Use
olololol olololololololololololololololololololololololololololololololololololololololololol
O set to 1 on command line for ONLINE-style
M set to 1 in tmac.an for manpager use
Z set to 1 in tmac.an for debugging
Another register, X, is used internally.
Symbol Name Description
olololololol olololol olololololololololololololololololololololololololololololololololololololololololololol
`` lq left (start) quote
'' rq right (end) quote
ux Unix tm
DA current date (e.g. 16:34:00 Jan 30, 1991)
DY current date (e.g. Jan 30, 1991)
CT current date (e.g. Wed Jan 30 16:34:00 1991)
TM current time (e.g. 16:34:00)
They are accessed with ``\*(xx'', where xx is the name of the string.
Request Cause Explanation
Break?
ololololololololololololololol olololololol olololololololololololololololololololololololololololololololololololololololol
.B t no Text t is bold. Quote to imbed blanks.
.BI t no Join words of t alternating bold and italic
.BR t no Join words of t alternating bold and Roman
.HP i yes Indented paragraph with hanging indent set
to i (default 0.8i).
.I t no Text t is italic. Quote to imbed blanks.
.IB t no Join words of t alternating italic and bold
.IP t i yes Set prevailing indent to i (default 0.8i).
Begin indented paragraph with hanging tag
given by first argument. Tag t is always
placed on a separate line.
.IR t no Join words of t alternating italic and Roman
.LP yes Same as .PP.
.PP yes Begin paragraph. Set prevailing indent 0.8i.
.R t no Text t is Roman. Quote to imbed blanks.
.RB t no Join words of t alternating Roman and bold
.RE i yes End of relative indent. Set prevailing
indent to amount i (default 0.8i).
.RI t no Join words of t alternating Roman and italic
.RP t yes Like .IP, but use relative indent. Must
end the section with .RE.
.RS i yes Start relative indent, move left margin
in distance i (default 0.8i).
.SH t yes Section. Quote to imbed blanks.
.SS t yes Subsection. Quote to imbed blanks. No
indent for t.
.TH n s c v d f yes Begin page named n of chapter s; c is
the chapter name; d is the date of the
most recent change; v is version number;
f is format (optional) and if ONLINE, format
for online viewing (use .EX at the bottom).
Note that now you can set register ``O'' to 1
on the command line to do ONLINE/EX instead.
Sets prevailing indent and tabs 0.8i.
The name, or list of names, by which the command is called, followed by a dash and then a one-line summary of the action performed. All in Roman font, this section contains no nroff(1) commands or escapes, and no macro requests. It is used to generate the whatis(1) database so it should be clean.
Functions:
Filenames, and references to commands or functions described elswhere in the manual, are italicised. The names of options, variables and other literal terms are in boldface.
.\" this is a comment .TH DEMO 1 "Commands Manual" "Version 1.0" "\*(DA" .SH NAME demo \- show how to use -man package \" this is a comment .SH SYNOPSIS .B demo [ .I options ] .I file .SH DESCRIPTION This is a test for showing how to use the .BR nroff (1) man package. It shows how to use .TH, .SH, .PP, .I, and .IP commands. .PP This will be a new paragraph. You can also use normal .BR nroff (1) commands in the text. .SS NROFF COMMANDS: .IP '\\"' This is the comment command. Note how you have to quote this sucker! You'll probably never have to write an .BR nroff (1) manpage, so don't worry about it. .IP nf No fill mode (the normal mode is fill mode where things get justified right and left). .IP fi Re-enter fill mode. .IP br Break line here no matter what. .IP sp Vertical space (also causes a break to occur). .sp Note that to continue an indent and make a new paragraph (as is the case here), just put in a space (.sp). .PP Now we should be at a new paragraph.
Executing ``nroff -man demo.man'' results in the following output:
DEMO (1) Commands Manual DEMO (1)
NAME
demo - show how to use -man package
SYNOPSIS
demo [ options ] file
DESCRIPTION
This is a test for showing how to use the nroff(1)
man package. It shows how to use .TH, .SH, .PP, .I,
and .IP commands.
This will be a new paragraph. You can also use normal
nroff(1) commands in the text.
NROFF COMMANDS:
\"
This is the comment command. Note how you have to
quote this sucker! You'll probably never have to
write an nroff(1) manpage, so don't worry about
it.
nf
No fill mode (the normal mode is fill mode where
things get justified right and left).
fi
Re-enter fill mode.
br
Break line here no matter what.
sp
Vertical space (also causes a break to occur).
Note that to continue an indent and make a new
paragraph (as is the case here), just put in a
space (.sp).
Now we should be at a new paragraph.
Version 1.0 23:33:57 2/25/90 1
net: rosenkra@convex.com CIS: 71460,17 GENIE: W.ROSENKRANZ